home *** CD-ROM | disk | FTP | other *** search
/ Nebula 1 / Nebula One.iso / Utilities / Unix / cvs-960311 / info / cvs.info-1 (.txt) < prev    next >
GNU Info File  |  1996-01-24  |  50KB  |  926 lines
  1. This is Info file cvs.info, produced by Makeinfo-1.64 from the input
  2. file ./cvs.texinfo.
  3.    Copyright (C) 1992, 1993 Signum Support AB Copyright (C) 1993, 1994
  4. Free Software Foundation, Inc.
  5.    Permission is granted to make and distribute verbatim copies of this
  6. manual provided the copyright notice and this permission notice are
  7. preserved on all copies.
  8.    Permission is granted to copy and distribute modified versions of
  9. this manual under the conditions for verbatim copying, provided also
  10. that the section entitled "GNU General Public License" is included
  11. exactly as in the original, and provided that the entire resulting
  12. derived work is distributed under the terms of a permission notice
  13. identical to this one.
  14.    Permission is granted to copy and distribute translations of this
  15. manual into another language, under the above conditions for modified
  16. versions, except that the section entitled "GNU General Public License"
  17. and this permission notice may be included in translations approved by
  18. the Free Software Foundation instead of in the original English.
  19. File: cvs.info,  Node: Top,  Next: Preface,  Up: (dir)
  20.    This info manual describes how to use and administer CVS and is
  21. updated to release 1.4 or something similar.
  22. * Menu:
  23. * Preface::                     About this manual
  24. * What is CVS?::                What is CVS?
  25. * Basic concepts::              Basic concepts of revision management
  26. * A sample session::            A tour of basic CVS usage
  27. * Repository::                  Where all your sources are stored
  28. * Starting a new project::      Starting a project with CVS
  29. * Multiple developers::         How CVS helps a group of developers
  30. * Branches::                    Parallel development explained
  31. * Merging::                     How to move changes between branches
  32. * Recursive behavior::          CVS descends directories
  33. * Adding files::                Adding files to a module
  34. * Removing files::              Removing files from a module
  35. * Tracking sources::            Tracking third-party sources
  36. * Moving files::                Moving and renaming files
  37. * Moving directories::          Moving and renaming directories
  38. * Keyword substitution::        CVS can include the revision inside the file
  39. * Binary files::                CVS can handle binary files
  40. * Revision management::         Policy questions for revision management
  41. * Invoking CVS::                Reference manual for CVS commands
  42. * Administrative files::        Reference manual for the Administrative files
  43. * Environment variables::       All environment variables which affect CVS
  44. * Troubleshooting::             Some tips when nothing works
  45. * Copying::                     GNU GENERAL PUBLIC LICENSE
  46. * Index::                       Index
  47. File: cvs.info,  Node: Preface,  Next: What is CVS?,  Prev: Top,  Up: Top
  48. About this manual
  49. *****************
  50.    Up to this point, one of the weakest parts of CVS has been the
  51. documentation.  CVS is a complex program.  Previous versions of the
  52. manual were written in the manual page format, which is not really well
  53. suited for such a complex program.
  54.    When writing this manual, I had several goals in mind:
  55.    * No knowledge of RCS should be necessary.
  56.    * No previous knowledge of revision control software should be
  57.      necessary.  All terms, such as "revision numbers", "revision
  58.      trees" and "merging" are explained as they are introduced.
  59.    * The manual should concentrate on the things CVS users want to do,
  60.      instead of what the CVS commands can do.  The first part of this
  61.      manual leads you through things you might want to do while doing
  62.      development, and introduces the relevant CVS commands as they are
  63.      needed.
  64.    * Information should be easy to find.  In the reference manual in
  65.      the appendices almost all information about every CVS command is
  66.      gathered together.  There is also an extensive index, and a lot of
  67.      cross references.
  68.    This manual was contributed by Signum Support AB in Sweden.  Signum
  69. is yet another in the growing list of companies that support free
  70. software.  You are free to copy both this manual and the CVS program.
  71. *Note Copying::, for the details.  Signum Support offers support
  72. contracts and binary distribution for many programs, such as CVS, GNU
  73. Emacs, the GNU C compiler and others.  Write to us for more information.
  74.      Signum Support AB
  75.      Box 2044
  76.      S-580 02  Linkoping
  77.      Sweden
  78.      
  79.      Email: info@signum.se
  80.      Phone: +46 (0)13 - 21 46 00
  81.      Fax:   +46 (0)13 - 21 47 00
  82.    Another company selling support for CVS is Cyclic Software, web:
  83. `http://www.cyclic.com/', email: `info@cyclic.com'.
  84. * Menu:
  85. * Checklist::
  86. * Credits::
  87. * BUGS::
  88. File: cvs.info,  Node: Checklist,  Next: Credits,  Up: Preface
  89. Checklist for the impatient reader
  90. ==================================
  91.    CVS is a complex system.  You will need to read the manual to be
  92. able to use all of its capabilities.  There are dangers that can easily
  93. be avoided if you know about them, and this manual tries to warn you
  94. about them.  This checklist is intended to help you avoid the dangers
  95. without reading the entire manual.  If you intend to read the entire
  96. manual you can skip this table.
  97. Binary files
  98.      CVS can handle binary files, but you must have RCS release 5.5 or
  99.      later and a release of GNU diff that supports the `-a' flag
  100.      (release 1.15 and later are OK).  You must also configure both RCS
  101.      and CVS to handle binary files when you install them.
  102.      Keword substitution can be a source of trouble with binary files.
  103.      *Note Keyword substitution::, for solutions.
  104. The `admin' command
  105.      Uncareful use of the `admin' command can cause CVS to cease
  106.      working.  *Note admin::, before trying to use it.
  107. File: cvs.info,  Node: Credits,  Next: BUGS,  Prev: Checklist,  Up: Preface
  108. Credits
  109. =======
  110.    Roland Pesch, Cygnus Support <pesch@cygnus.com> wrote the manual
  111. pages which were distributed with CVS 1.3.  Appendix A and B contain
  112. much text that was extracted from them.  He also read an early draft of
  113. this manual and contributed many ideas and corrections.
  114.    The mailing-list `info-cvs' is sometimes informative. I have
  115. included information from postings made by the following persons: David
  116. G. Grubbs <dgg@think.com>.
  117.    Some text has been extracted from the man pages for RCS.
  118.    The CVS FAQ (*note What is CVS?::.) by David G. Grubbs has been used
  119. as a check-list to make sure that this manual is as complete as
  120. possible.  (This manual does however not include all of the material in
  121. the FAQ).  The FAQ contains a lot of useful information.
  122.    In addition, the following persons have helped by telling me about
  123. mistakes I've made: Roxanne Brunskill <rbrunski@datap.ca>, Kathy Dyer
  124. <dyer@phoenix.ocf.llnl.gov>, Karl Pingle <pingle@acuson.com>, Thomas A
  125. Peterson <tap@src.honeywell.com>, Inge Wallin <ingwa@signum.se>, Dirk
  126. Koschuetzki <koschuet@fmi.uni-passau.de> and Michael Brown
  127. <brown@wi.extrel.com>.
  128. File: cvs.info,  Node: BUGS,  Prev: Credits,  Up: Preface
  129.    This manual is known to have room for improvement.  Here is a list
  130. of known deficiencies:
  131.    * In the examples, the output from CVS is sometimes displayed,
  132.      sometimes not.
  133.    * The input that you are supposed to type in the examples should
  134.      have a different font than the output from the computer.
  135.    * This manual should be clearer about what file permissions you
  136.      should set up in the repository, and about setuid/setgid.
  137.    * Some of the chapters are not yet complete.  They are noted by
  138.      comments in the `cvs.texinfo' file.
  139.    * This list is not complete.  If you notice any error, omission, or
  140.      something that is unclear, please send mail to
  141.      bug-cvs@prep.ai.mit.edu.
  142.    I hope that you will find this manual useful, despite the
  143. above-mentioned shortcomings.
  144.                                                 Linkoping, October 1993
  145.                                                          Per Cederqvist
  146. File: cvs.info,  Node: What is CVS?,  Next: Basic concepts,  Prev: Preface,  Up: Top
  147. What is CVS?
  148. ************
  149.    CVS is a version control system.  Using it, you can record the
  150. history of your source files.
  151.    For example, bugs sometimes creep in when software is modified, and
  152. you might not detect the bug until a long time after you make the
  153. modification.  With CVS, you can easily retrieve old versions to see
  154. exactly which change caused the bug.  This can sometimes be a big help.
  155.    You could of course save every version of every file you have ever
  156. created.  This would however waste an enormous amount of disk space.
  157. CVS stores all the versions of a file in a single file in a clever way
  158. that only stores the differences between versions.
  159.    CVS also helps you if you are part of a group of people working on
  160. the same project.  It is all too easy to overwrite each others' changes
  161. unless you are extremely careful.  Some editors, like GNU Emacs, try to
  162. make sure that the same file is never modified by two people at the
  163. same time.  Unfortunately, if someone is using another editor, that
  164. safeguard will not work.  CVS solves this problem by insulating the
  165. different developers from each other.  Every developer works in his own
  166. directory, and CVS merges the work when each developer is done.
  167.    CVS started out as a bunch of shell scripts written by Dick Grune,
  168. posted to `comp.sources.unix' in the volume 6 release of December,
  169. 1986.  While no actual code from these shell scripts is present in the
  170. current version of CVS much of the CVS conflict resolution algorithms
  171. come from them.
  172.    In April, 1989, Brian Berliner designed and coded CVS.  Jeff Polk
  173. later helped Brian with the design of the CVS module and vendor branch
  174. support.
  175.    You can get CVS via anonymous ftp from a number of sites, for
  176. instance prep.ai.mit.edu in `pub/gnu'.
  177.    There is a mailing list for CVS where bug reports can be sent,
  178. questions can be asked, an FAQ is posted, and discussion about future
  179. enhancements to CVS take place.  To submit a message to the list, write
  180. to <info-cvs@prep.ai.mit.edu>.  To subscribe or unsubscribe, write to
  181. <info-cvs-request@prep.ai.mit.edu>. Please be specific about your email
  182. address.
  183.    Work is in progress on creating a newsgroup for CVS-related topics.
  184. It will appear somewhere under the `gnu.' hierarchy.  Gateways to and
  185. from the mailing list will be set up.
  186.    The FTP site think.com has some CVS material in the `/pub/cvs'
  187. subdirectory.  Currently (late summer 1993) it contains an excellent
  188. FAQ (Frequently Asked Questions, with answers), and an improved (but
  189. unofficial) version of CVS.
  190. CVS is not...
  191. =============
  192.    CVS can do a lot of things for you, but it does not try to be
  193. everything for everyone.
  194. CVS is not a build system.
  195.      Though the structure of your repository and modules file interact
  196.      with your build system (e.g. `Makefile's), they are essentially
  197.      independent.
  198.      CVS does not dictate how you build anything.  It merely stores
  199.      files for retrieval in a tree structure you devise.
  200.      CVS does not dictate how to use disk space in the checked out
  201.      working directories.  If you write your `Makefile's or scripts in
  202.      every directory so they have to know the relative positions of
  203.      everything else, you wind up requiring the entire repository to be
  204.      checked out.  That's simply bad planning.
  205.      If you modularize your work, and construct a build system that
  206.      will share files (via links, mounts, `VPATH' in `Makefile's,
  207.      etc.), you can arrange your disk usage however you like.
  208.      But you have to remember that *any* such system is a lot of work
  209.      to construct and maintain.  CVS does not address the issues
  210.      involved.  You must use your brain and a collection of other tools
  211.      to provide a build scheme to match your plans.
  212.      Of course, you should place the tools created to support such a
  213.      build system (scripts, `Makefile's, etc) under CVS.
  214. CVS is not a substitute for management.
  215.      Your managers and project leaders are expected to talk to you
  216.      frequently enough to make certain you are aware of schedules,
  217.      merge points, branch names and release dates.  If they don't, CVS
  218.      can't help.
  219.      CVS is an instrument for making sources dance to your tune.  But
  220.      you are the piper and the composer.  No instrument plays itself or
  221.      writes its own music.
  222. CVS is not a substitute for developer communication.
  223.      When faced with conflicts within a single file, most developers
  224.      manage to resolve them without too much effort.  But a more
  225.      general definition of "conflict" includes problems too difficult
  226.      to solve without communication between developers.
  227.      CVS cannot determine when simultaneous changes within a single
  228.      file, or across a whole collection of files, will logically
  229.      conflict with one another.  Its concept of a "conflict" is purely
  230.      textual, arising when two changes to the same base file are near
  231.      enough to spook the merge (i.e. `diff3') command.
  232.      CVS does not claim to help at all in figuring out non-textual or
  233.      distributed conflicts in program logic.
  234.      For example: Say you change the arguments to function `X' defined
  235.      in file `A'.  At the same time, someone edits file `B', adding new
  236.      calls to function `X' using the old arguments.  You are outside
  237.      the realm of CVS's competence.
  238.      Acquire the habit of reading specs and talking to your peers.
  239. CVS is not a configuration management system.
  240.      CVS is a source control system.  The phrase "configuration
  241.      management" is a marketing term, not an industry-recognized set of
  242.      functions.
  243.      A true "configuration management system" would contain elements of
  244.      the following:
  245.         * Source control.
  246.         * Dependency tracking.
  247.         * Build systems (i.e. What to build and how to find things
  248.           during a build.  What is shared?  What is local?)
  249.         * Bug tracking.
  250.         * Automated Testing procedures.
  251.         * Release Engineering documentation and procedures.
  252.         * Tape Construction.
  253.         * Customer Installation.
  254.         * A way for users to run different versions of the same
  255.           software on the same host at the same time.
  256.      CVS provides only the first.
  257.    This section is taken from release 2.3 of the CVS FAQ.
  258. File: cvs.info,  Node: Basic concepts,  Next: A sample session,  Prev: What is CVS?,  Up: Top
  259. Basic concepts
  260. **************
  261.    CVS stores all files in a centralized "repository": a directory
  262. (such as `/usr/local/cvsroot' or `user@remotehost:/usr/local/cvsroot')
  263. which is populated with a hierarchy of files and directories.  (*note
  264. Remote repositories::. for information about keeping the repository on
  265. a remote machine.)
  266.    Normally, you never access any of the files in the repository
  267. directly.  Instead, you use CVS commands to get your own copy of the
  268. files, and then work on that copy.  When you've finished a set of
  269. changes, you check (or "commit") them back into the repository.
  270.    The files in the repository are organized in "modules".  Each module
  271. is made up of one or more files, and can include files from several
  272. directories.  A typical usage is to define one module per project.
  273. * Menu:
  274. * Revision numbers::            The meaning of a revision number
  275. * Versions revisions releases::  Terminology used in this manual
  276. File: cvs.info,  Node: Revision numbers,  Next: Versions revisions releases,  Up: Basic concepts
  277. Revision numbers
  278. ================
  279.    Each version of a file has a unique "revision number".  Revision
  280. numbers look like `1.1', `1.2', `1.3.2.2' or even `1.3.2.2.4.5'.  A
  281. revision number always has an even number of period-separated decimal
  282. integers.  By default revision 1.1 is the first revision of a file.
  283. Each successive revision is given a new number by increasing the
  284. rightmost number by one.  The following figure displays a few
  285. revisions, with newer revisions to the right.
  286.             +-----+    +-----+    +-----+    +-----+    +-----+
  287.             ! 1.1 !----! 1.2 !----! 1.3 !----! 1.4 !----! 1.5 !
  288.             +-----+    +-----+    +-----+    +-----+    +-----+
  289.    CVS is not limited to linear development.  The "revision tree" can
  290. be split into "branches", where each branch is a self-maintained line of
  291. development.  Changes made on one branch can easily be moved back to
  292. the main trunk.
  293.    Each branch has a "branch number", consisting of an odd number of
  294. period-separated decimal integers.  The branch number is created by
  295. appending an integer to the revision number where the corresponding
  296. branch forked off.  Having branch numbers allows more than one branch
  297. to be forked off from a certain revision.
  298.    All revisions on a branch have revision numbers formed by appending
  299. an ordinal number to the branch number.  The following figure
  300. illustrates branching with an example.
  301.                                                           +-------------+
  302.                                Branch 1.2.2.3.2 ->        ! 1.2.2.3.2.1 !
  303.                                                         / +-------------+
  304.                                                        /
  305.                                                       /
  306.                       +---------+    +---------+    +---------+    +---------+
  307.      Branch 1.2.2 -> _! 1.2.2.1 !----! 1.2.2.2 !----! 1.2.2.3 !----! 1.2.2.4 !
  308.                     / +---------+    +---------+    +---------+    +---------+
  309.                    /
  310.                   /
  311.      +-----+    +-----+    +-----+    +-----+    +-----+
  312.      ! 1.1 !----! 1.2 !----! 1.3 !----! 1.4 !----! 1.5 !      <- The main trunk
  313.      +-----+    +-----+    +-----+    +-----+    +-----+
  314.                      !
  315.                      !
  316.                      !   +---------+    +---------+    +---------+
  317.      Branch 1.2.4 -> +---! 1.2.4.1 !----! 1.2.4.2 !----! 1.2.4.3 !
  318.                          +---------+    +---------+    +---------+
  319.    The exact details of how the branch number is constructed is not
  320. something you normally need to be concerned about, but here is how it
  321. works: When CVS creates a branch number it picks the first unused even
  322. integer, starting with 2.  So when you want to create a branch from
  323. revision 6.4 it will be numbered 6.4.2.  All branch numbers ending in a
  324. zero (such as 6.4.0) are used internally by CVS (*note Magic branch
  325. numbers::.).  The branch 1.1.1 has a special meaning.  *Note Tracking
  326. sources::.
  327. File: cvs.info,  Node: Versions revisions releases,  Prev: Revision numbers,  Up: Basic concepts
  328. Versions, revisions and releases
  329. ================================
  330.    A file can have several versions, as described above.  Likewise, a
  331. software product can have several versions.  A software product is
  332. often given a version number such as `4.1.1'.
  333.    Versions in the first sense are called "revisions" in this document,
  334. and versions in the second sense are called "releases".  To avoid
  335. confusion, the word "version" is almost never used in this document.
  336. File: cvs.info,  Node: A sample session,  Next: Repository,  Prev: Basic concepts,  Up: Top
  337. A sample session
  338. ****************
  339.    This section describes a typical work-session using CVS.  It assumes
  340. that a repository is set up (*note Repository::.).
  341.    Suppose you are working on a simple compiler.  The source consists
  342. of a handful of C files and a `Makefile'.  The compiler is called `tc'
  343. (Trivial Compiler), and the repository is set up so that there is a
  344. module called `tc'.
  345. * Menu:
  346. * Getting the source::          Creating a workspace
  347. * Committing your changes::     Making your work available to others
  348. * Cleaning up::                 Cleaning up
  349. * Viewing differences::         Viewing differences
  350. File: cvs.info,  Node: Getting the source,  Next: Committing your changes,  Up: A sample session
  351. Getting the source
  352. ==================
  353.    The first thing you must do is to get your own working copy of the
  354. source for `tc'.  For this, you use the `checkout' command:
  355.      $ cvs checkout tc
  356. This will create a new directory called `tc' and populate it with the
  357. source files.
  358.      $ cd tc
  359.      $ ls tc
  360.      CVS         Makefile    backend.c   driver.c    frontend.c  parser.c
  361.    The `CVS' directory is used internally by CVS.  Normally, you should
  362. not modify or remove any of the files in it.
  363.    You start your favorite editor, hack away at `backend.c', and a
  364. couple of hours later you have added an optimization pass to the
  365. compiler.  A note to RCS and SCCS users: There is no need to lock the
  366. files that you want to edit.  *Note Multiple developers:: for an
  367. explanation.
  368. File: cvs.info,  Node: Committing your changes,  Next: Cleaning up,  Prev: Getting the source,  Up: A sample session
  369. Committing your changes
  370. =======================
  371.    When you have checked that the compiler is still compilable you
  372. decide to make a new version of `backend.c'.
  373.      $ cvs commit backend.c
  374. CVS starts an editor, to allow you to enter a log message.  You type in
  375. "Added an optimization pass.", save the temporary file, and exit the
  376. editor.
  377.    The environment variable `$CVSEDITOR' determines which editor is
  378. started.  If `$CVSEDITOR' is not set, then if the environment variable
  379. `$EDITOR' is set, it will be used. If both `$CVSEDITOR' and `$EDITOR'
  380. are not set then the editor defaults to `vi'.  If you want to avoid the
  381. overhead of starting an editor you can specify the log message on the
  382. command line using the `-m' flag instead, like this:
  383.      $ cvs commit -m "Added an optimization pass" backend.c
  384. File: cvs.info,  Node: Cleaning up,  Next: Viewing differences,  Prev: Committing your changes,  Up: A sample session
  385. Cleaning up
  386. ===========
  387.    Before you turn to other tasks you decide to remove your working
  388. copy of tc.  One acceptable way to do that is of course
  389.      $ cd ..
  390.      $ rm -r tc
  391. but a better way is to use the `release' command (*note release::.):
  392.      $ cd ..
  393.      $ cvs release -d tc
  394.      M driver.c
  395.      ? tc
  396.      You have [1] altered files in this repository.
  397.      Are you sure you want to release (and delete) module `tc': n
  398.      ** `release' aborted by user choice.
  399.    The `release' command checks that all your modifications have been
  400. committed.  If history logging is enabled it also makes a note in the
  401. history file.  *Note history file::.
  402.    When you use the `-d' flag with `release', it also removes your
  403. working copy.
  404.    In the example above, the `release' command wrote a couple of lines
  405. of output.  `? tc' means that the file `tc' is unknown to CVS.  That is
  406. nothing to worry about: `tc' is the executable compiler, and it should
  407. not be stored in the repository.  *Note cvsignore::, for information
  408. about how to make that warning go away.  *Note release output::, for a
  409. complete explanation of all possible output from `release'.
  410.    `M driver.c' is more serious.  It means that the file `driver.c' has
  411. been modified since it was checked out.
  412.    The `release' command always finishes by telling you how many
  413. modified files you have in your working copy of the sources, and then
  414. asks you for confirmation before deleting any files or making any note
  415. in the history file.
  416.    You decide to play it safe and answer `n RET' when `release' asks
  417. for confirmation.
  418. File: cvs.info,  Node: Viewing differences,  Prev: Cleaning up,  Up: A sample session
  419. Viewing differences
  420. ===================
  421.    You do not remember modifying `driver.c', so you want to see what
  422. has happened to that file.
  423.      $ cd tc
  424.      $ cvs diff driver.c
  425.    This command runs `diff' to compare the version of `driver.c' that
  426. you checked out with your working copy.  When you see the output you
  427. remember that you added a command line option that enabled the
  428. optimization pass.  You check it in, and release the module.
  429.      $ cvs commit -m "Added an optimization pass" driver.c
  430.      Checking in driver.c;
  431.      /usr/local/cvsroot/tc/driver.c,v  <--  driver.c
  432.      new revision: 1.2; previous revision: 1.1
  433.      done
  434.      $ cd ..
  435.      $ cvs release -d tc
  436.      ? tc
  437.      You have [0] altered files in this repository.
  438.      Are you sure you want to release (and delete) module `tc': y
  439. File: cvs.info,  Node: Repository,  Next: Starting a new project,  Prev: A sample session,  Up: Top
  440. The Repository
  441. **************
  442.    Figure 3 below shows a typical setup of a repository.  Only
  443. directories are shown below.
  444.      /usr
  445.       |
  446.       +--local
  447.       |   |
  448.       |   +--cvsroot
  449.       |   |    |
  450.       |   |    +--CVSROOT
  451.                |      (administrative files)
  452.                |
  453.                +--gnu
  454.                |   |
  455.                |   +--diff
  456.                |   |   (source code to GNU diff)
  457.                |   |
  458.                |   +--rcs
  459.                |   |   (source code to RCS)
  460.                |   |
  461.                |   +--cvs
  462.                |       (source code to CVS)
  463.                |
  464.                +--yoyodyne
  465.                    |
  466.                    +--tc
  467.                    |    |
  468.                    |    +--man
  469.                    |    |
  470.                    |    +--testing
  471.                    |
  472.                    +--(other Yoyodyne software)
  473.    There are a couple of different ways to tell CVS where to find the
  474. repository.  You can name the repository on the command line
  475. explicitly, with the `-d' (for "directory") option:
  476.      cvs -d /usr/local/cvsroot checkout yoyodyne/tc
  477.    Or you can set the `$CVSROOT' environment variable to an absolute
  478. path to the root of the repository, `/usr/local/cvsroot' in this
  479. example.  To set `$CVSROOT', all `csh' and `tcsh' users should have
  480. this line in their `.cshrc' or `.tcshrc' files:
  481.      setenv CVSROOT /usr/local/cvsroot
  482. `sh' and `bash' users should instead have these lines in their
  483. `.profile' or `.bashrc':
  484.      CVSROOT=/usr/local/cvsroot
  485.      export CVSROOT
  486.    A repository specified with `-d' will override the `$CVSROOT'
  487. environment variable.  Once you've checked a working copy out from the
  488. repository, it will remember where its repository is (the information
  489. is recorded in the `CVS/Root' file in the working copy).
  490.    The `-d' option and the `CVS/Root' file both override the `$CVSROOT'
  491. environment variable; however, CVS will complain if the `-d' argument
  492. and the `CVS/Root' file disagree.
  493.    There is nothing magical about the name `/usr/local/cvsroot'.  You
  494. can choose to place the repository anywhere you like.  *Note Remote
  495. repositories:: to learn how the repository can be on a different
  496. machine than your working copy of the sources.
  497.    The repository is split in two parts.  `$CVSROOT/CVSROOT' contains
  498. administrative files for CVS.  The other directories contain the actual
  499. user-defined modules.
  500. * Menu:
  501. * User modules::                The structure of the repository
  502. * Intro administrative files::  Defining modules
  503. * Multiple repositories::       Multiple repositories
  504. * Creating a repository::       Creating a repository
  505. * Remote repositories::         Accessing repositories on remote machines
  506. File: cvs.info,  Node: User modules,  Next: Intro administrative files,  Up: Repository
  507. User modules
  508. ============
  509.        `$CVSROOT'
  510.          |
  511.          +--yoyodyne
  512.          |   |
  513.          |   +--tc
  514.          |   |   |
  515.                  +--Makefile,v
  516.                  +--backend.c,v
  517.                  +--driver.c,v
  518.                  +--frontend.c,v
  519.                  +--parser.c,v
  520.                  +--man
  521.                  |    |
  522.                  |    +--tc.1,v
  523.                  |
  524.                  +--testing
  525.                       |
  526.                       +--testpgm.t,v
  527.                       +--test2.t,v
  528.    The figure above shows the contents of the `tc' module inside the
  529. repository.  As you can see all file names end in `,v'.  The files are
  530. "history files".  They contain, among other things, enough information
  531. to recreate any revision of the file, a log of all commit messages and
  532. the user-name of the person who committed the revision.  CVS uses the
  533. facilities of RCS, a simpler version control system, to maintain these
  534. files.  For a full description of the file format, see the `man' page
  535. `rcsfile(5)'.
  536. * Menu:
  537. * File permissions::            File permissions
  538. File: cvs.info,  Node: File permissions,  Up: User modules
  539. File permissions
  540. ----------------
  541.    All `,v' files are created read-only, and you should not change the
  542. permission of those files.  The directories inside the repository
  543. should be writable by the persons that have permission to modify the
  544. files in each directory.  This normally means that you must create a
  545. UNIX group (see group(5)) consisting of the persons that are to edit
  546. the files in a project, and set up the repository so that it is that
  547. group that owns the directory.
  548.    This means that you can only control access to files on a
  549. per-directory basis.
  550.    CVS tries to set up reasonable file permissions for new directories
  551. that are added inside the tree, but you must fix the permissions
  552. manually when a new directory should have different permissions than its
  553. parent directory.
  554.    Since CVS was not written to be run setuid, it is unsafe to try to
  555. run it setuid.  You cannot use the setuid features of RCS together with
  556. File: cvs.info,  Node: Intro administrative files,  Next: Multiple repositories,  Prev: User modules,  Up: Repository
  557. The administrative files
  558. ========================
  559.    The directory `$CVSROOT/CVSROOT' contains some "administrative
  560. files".  *Note Administrative files::, for a complete description.  You
  561. can use CVS without any of these files, but some commands work better
  562. when at least the `modules' file is properly set up.
  563.    The most important of these files is the `modules' file.  It defines
  564. all modules in the repository.  This is a sample `modules' file.
  565.      CVSROOT         -i mkmodules CVSROOT
  566.      modules         -i mkmodules CVSROOT modules
  567.      cvs             gnu/cvs
  568.      rcs             gnu/rcs
  569.      diff            gnu/diff
  570.      tc              yoyodyne/tc
  571.    The `modules' file is line oriented.  In its simplest form each line
  572. contains the name of the module, whitespace, and the directory where
  573. the module resides.  The directory is a path relative to `$CVSROOT'.
  574. The last for lines in the example above are examples of such lines.
  575.    Each module definition can contain options.  The `-i mkmodules' is
  576. an example of an option.  It arranges for CVS to run the `mkmodules'
  577. program whenever any file in the module CVSROOT is committed.  That
  578. program is responsible for checking out read-only copies from the RCS
  579. "history files" of all the administrative files.  These read-only
  580. copies are used internally by CVS.  You should never edit them directly.
  581.    The line that defines the module called `modules' uses features that
  582. are not explained here.  *Note modules::, for a full explanation of all
  583. the available features.
  584. Editing administrative files
  585. ----------------------------
  586.    You edit the administrative files in the same way that you would edit
  587. any other module.  Use `cvs checkout CVSROOT' to get a working copy,
  588. edit it, and commit your changes in the normal way.
  589.    It is possible to commit an erroneous administrative file.  You can
  590. often fix the error and check in a new revision, but sometimes a
  591. particularly bad error in the administrative file makes it impossible
  592. to commit new revisions.
  593. File: cvs.info,  Node: Multiple repositories,  Next: Creating a repository,  Prev: Intro administrative files,  Up: Repository
  594. Multiple repositories
  595. =====================
  596.    In some situations it is a good idea to have more than one
  597. repository, for instance if you have two development groups that work
  598. on separate projects without sharing any code.  All you have to do to
  599. have several repositories is to specify the appropriate repository,
  600. using the `CVSROOT' environment variable, the `-d' option to CVS, or
  601. (once you have checked out a working directories) by simply allowing
  602. CVS to use the repository that was used to check out the working
  603. directory (*note Repository::.).
  604.    Notwithstanding, it can be confusing to have two or more
  605. repositories.
  606.    None of the examples in this manual show multiple repositories.
  607. File: cvs.info,  Node: Creating a repository,  Next: Remote repositories,  Prev: Multiple repositories,  Up: Repository
  608. Creating a repository
  609. =====================
  610.    See the instructions in the `INSTALL' file in the CVS distribution.
  611. File: cvs.info,  Node: Remote repositories,  Prev: Creating a repository,  Up: Repository
  612. Remote repositories
  613. ===================
  614.    Your working copy of the sources can be on a different machine than
  615. the repository.  Generally, using a remote repository is just like
  616. using a local one, except that the format of the repository name is:
  617.              user@hostname:/path/to/repository
  618.    The details of exactly what needs to be set up depend on how you are
  619. connecting to the server.
  620. * Menu:
  621. * Connecting via rsh::          Using the `rsh' program to connect
  622. * Password authenticated::      Direct connections using passwords
  623. * Kerberos authenticated::      Direct connections with kerberos
  624. File: cvs.info,  Node: Connecting via rsh,  Next: Password authenticated,  Up: Remote repositories
  625. Connecting with rsh
  626. -------------------
  627.    CVS uses the `rsh' protocol to perform these operations, so the
  628. remote user host needs to have a `.rhosts' file which grants access to
  629. the local user.
  630.    For example, suppose you are the user `mozart' on the local machine
  631. `anklet.grunge.com', and the server machine is
  632. `chainsaw.brickyard.com'.  On chainsaw, put the following line into the
  633. file `.rhosts' in `bach''s home directory:
  634.      anklet.grunge.com  mozart
  635.    Then test that `rsh' is working with
  636.      rsh -l bach chainsaw.brickyard.com echo $PATH
  637.    Next you have to make sure that `rsh' will be able to find the
  638. server.  Make sure that the path which `rsh' printed in the above
  639. example includes the directory containing a program named `cvs' which
  640. is the server.  You need to set the path in `.bashrc', `.cshrc', etc.,
  641. not `.login' or `.profile'.  Alternately, you can set the environment
  642. variable `CVS_SERVER' on the client machine to the filename of the
  643. server you want to use, for example `/usr/local/bin/cvs-1.6'.
  644.    There is no need to edit `inetd.conf' or start a CVS server daemon.
  645.    Continuing our example, supposing you want to access the module
  646. `foo' in the repository `/usr/local/cvsroot/', on machine
  647. `chainsaw.brickyard.com', you are ready to go:
  648.      cvs -d bach@chainsaw.brickyard.com:/user/local/cvsroot checkout foo
  649.    (The `bach@' can be omitted if the username is the same on both the
  650. local and remote hosts.)
  651. File: cvs.info,  Node: Password authenticated,  Next: Kerberos authenticated,  Prev: Connecting via rsh,  Up: Remote repositories
  652. Direct connection with password authentication
  653. ----------------------------------------------
  654.    The CVS client can also connect to the server using a password
  655. protocol.  This is particularly useful if using `rsh' is not feasible
  656. (for example, the server is behind a firewall), and Kerberos also is
  657. not available.
  658.    To use this method, it is necessary to make some adjustments on both
  659. the server and client sides.
  660. * Menu:
  661. * Password authentication server::     Setting up the server
  662. * Password authentication client::     Using the client
  663. * Password authentication security::   What this method does and does not do
  664. File: cvs.info,  Node: Password authentication server,  Next: Password authentication client,  Up: Password authenticated
  665. Setting up the server for password authentication
  666. .................................................
  667.    On the server side, the file `/etc/inetd.conf' needs to be edited so
  668. `inetd' knows to run the command `cvs pserver' when it receives a
  669. connection on the right port.  By default, the port number is 2401; it
  670. would be different if your client were compiled with `CVS_AUTH_PORT'
  671. defined to something else, though.
  672.    If your `inetd' allows raw port numbers in `/etc/inetd.conf', then
  673. the following (all on a single line in `inetd.conf') should be
  674. sufficient:
  675.      2401  stream  tcp  nowait  root  /usr/local/bin/cvs
  676.      cvs -b /usr/local/bin pserver
  677.    The `-b' option specifies the directory which contains the RCS
  678. binaries on the server.
  679.    If your `inetd' wants a symbolic service name instead of a raw port
  680. number, then put this in `/etc/services':
  681.      cvspserver      2401/tcp
  682.    and put `cvspserver' instead of `2401' in `inetd.conf'.
  683.    Once the above is taken care of, restart your `inetd', or do
  684. whatever is necessary to force it to reread its initialization files.
  685.    Because the client stores and transmits passwords in cleartext
  686. (almost--see *Note Password authentication security:: for details), a
  687. separate CVS password file may be used, so people don't compromise their
  688. regular passwords when they access the repository.  This file is
  689. `$CVSROOT/CVSROOT/passwd' (*note Intro administrative files::.).  Its
  690. format is similar to `/etc/passwd', except that it only has two fields,
  691. username and password.  For example:
  692.      bach:ULtgRLXo7NRxs
  693.      cwang:1sOp854gDF3DY
  694.    The password is encrypted according to the standard Unix `crypt()'
  695. function, so it is possible to paste in passwords directly from regular
  696. Unix `passwd' files.
  697.    When authenticating a password, the server first checks for the user
  698. in the CVS `passwd' file.  If it finds the user, it compares against
  699. that password.  If it does not find the user, or if the CVS `passwd'
  700. file does not exist, then the server tries the system's `/etc/passwd'
  701. file.  In either case, assuming the password is correct, the server
  702. switches to run as that user immediately after authentication, so that
  703. it will have no privileges which that user would not have.  Therefore
  704. it is necessary that usernames in the CVS `passwd' file be valid
  705. usernames on the system.
  706.    Right now, the only way to put a password in the CVS `passwd' file
  707. is to paste it there from somewhere else.  Someday, there may be a `cvs
  708. passwd' command.
  709. File: cvs.info,  Node: Password authentication client,  Next: Password authentication security,  Prev: Password authentication server,  Up: Password authenticated
  710. Using the client with password authentication
  711. .............................................
  712.    Before connecting to the server, the client must "log in" with the
  713. command `cvs login'.  Logging in verifies a password with the server,
  714. and also records the password for later transactions with the server.
  715. The `cvs login' command needs to know the username, server hostname,
  716. and full repository path, and it gets this information from the
  717. repository argument or the `CVSROOT' environment variable.
  718.    `cvs login' is interactive -- it prompts for a password:
  719.      cvs -d bach@chainsaw.brickyard.com:/usr/local/cvsroot login
  720.      CVS password:
  721.    The password is checked with the server; if it is correct, the
  722. `login' succeeds, else it fails, complaining that the password was
  723. incorrect.
  724.    Once you have logged in, you can force CVS to connect directly to
  725. the server and authenticate with the stored password by prefixing the
  726. repository with `:pserver:':
  727.      cvs -d :pserver:bach@chainsaw.brickyard.com:/usr/local/cvsroot checkout foo
  728.    The `:pserver:' is necessary because without it, CVS will assume it
  729. should use `rsh' to connect with the server (*note Connecting via
  730. rsh::.).  (Once you have a working copy checked out and are running CVS
  731. commands from within it, there is no longer any need to specify the
  732. repository explicitly, because CVS records it in the working copy's
  733. `CVS' subdirectory.)
  734.    Passwords are stored by default in the file `$HOME/.cvspass'.  Its
  735. format is human-readable, but don't edit it unless you know what you
  736. are doing.  The passwords are not stored in cleartext, but are
  737. trivially encoded to protect them from "innocent" compromise (i.e.,
  738. inadvertently being seen by a system administrator who happens to look
  739. at that file).
  740.    The `CVS_PASSFILE' environment variable overrides this default.  If
  741. you use this variable, make sure you set it *before* `cvs login' is
  742. run.  If you were to set it after running `cvs login', then later CVS
  743. commands would be unable to look up the password for transmission to
  744. the server.
  745.    The `CVS_PASSWORD' environment variable overrides *all* stored
  746. passwords.  If it is set, CVS will use it for all password-authenticated
  747. connections.
  748. File: cvs.info,  Node: Password authentication security,  Prev: Password authentication client,  Up: Password authenticated
  749. Security considerations with password authentication
  750. ....................................................
  751.    The passwords are stored on the client side in a trivial encoding of
  752. the cleartext, and transmitted in the same encoding.  The encoding is
  753. done only to prevent inadvertent password compromises (i.e., a system
  754. administrator accidentally looking at the file), and will not prevent
  755. even a naive attacker from gaining the password.
  756.    The separate CVS password file (*note Password authentication
  757. server::.) allows people to use a different password for repository
  758. access than for login access.  On the other hand, once a user has
  759. access to the repository, she can execute programs on the server system
  760. through a variety of means.  Thus, repository access implies fairly
  761. broad system access as well.  It might be possible to modify CVS to
  762. prevent that, but no one has done so as of this writing.  Furthermore,
  763. there may be other security problems with CVS; it is not a simple
  764. program and determining how people might use it to gain access to a
  765. system is difficult.
  766.    In summary, anyone who gets the password gets repository access, and
  767. some measure of general system access as well.  The password is
  768. available to anyone who can sniff network packets or read a protected
  769. (i.e., user read-only) file.  If you want real security, get Kerberos.
  770. File: cvs.info,  Node: Kerberos authenticated,  Prev: Password authenticated,  Up: Remote repositories
  771. Direct connection with kerberos
  772. -------------------------------
  773.    The main disadvantage of using rsh is that all the data needs to
  774. pass through additional programs, so it may be slower.  So if you have
  775. kerberos installed you can connect via a direct TCP connection,
  776. authenticating with kerberos (note that the data transmitted is *not*
  777. encrypted).
  778.    To do this, CVS needs to be compiled with kerberos support; when
  779. configuring CVS it tries to detect whether kerberos is present or you
  780. can use the `--with-krb4' flag to configure.
  781.    You need to edit `inetd.conf' on the server machine to run `cvs
  782. kserver'.  The client uses port 1999 by default; if you want to use
  783. another port specify it in the `CVS_CLIENT_PORT' environment variable
  784. on the client.  Set `CVS_CLIENT_PORT' to `-1' to force an rsh
  785. connection.
  786.    When you want to use CVS, get a ticket in the usual way (generally
  787. `kinit'); it must be a ticket which allows you to log into the server
  788. machine.  Then you are ready to go:
  789.      cvs -d chainsaw.brickyard.com:/user/local/cvsroot checkout foo
  790.    If CVS fails to connect, it will fall back to trying rsh.
  791. File: cvs.info,  Node: Starting a new project,  Next: Multiple developers,  Prev: Repository,  Up: Top
  792. Starting a project with CVS
  793. ***************************
  794.    Since CVS 1.x is bad at renaming files and moving them between
  795. directories, the first thing you do when you start a new project should
  796. be to think through your file organization.  It is not impossible--just
  797. awkward--to rename or move files.  *Note Moving files::.
  798.    What to do next depends on the situation at hand.
  799. * Menu:
  800. * Setting up the files::        Getting the files into the repository
  801. * Defining the module::         How to make a module of the files
  802. File: cvs.info,  Node: Setting up the files,  Next: Defining the module,  Up: Starting a new project
  803. Setting up the files
  804. ====================
  805.    The first step is to create the files inside the repository.  This
  806. can be done in a couple of different ways.
  807. * Menu:
  808. * From files::                  This method is useful with old projects
  809.                                 where files already exists.
  810. * From scratch::                Creating a module from scratch.
  811. File: cvs.info,  Node: From files,  Next: From scratch,  Up: Setting up the files
  812. Creating a module from a number of files
  813. ----------------------------------------
  814.    When you begin using CVS, you will probably already have several
  815. projects that can be put under CVS control.  In these cases the easiest
  816. way is to use the `import' command.  An example is probably the easiest
  817. way to explain how to use it.  If the files you want to install in CVS
  818. reside in `DIR', and you want them to appear in the repository as
  819. `$CVSROOT/yoyodyne/DIR', you can do this:
  820.      $ cd DIR
  821.      $ cvs import -m "Imported sources" yoyodyne/DIR yoyo start
  822.    Unless you supply a log message with the `-m' flag, CVS starts an
  823. editor and prompts for a message.  The string `yoyo' is a "vendor tag",
  824. and `start' is a "release tag".  They may fill no purpose in this
  825. context, but since CVS requires them they must be present.  *Note
  826. Tracking sources::, for more information about them.
  827.    You can now verify that it worked, and remove your original source
  828. directory.
  829.      $ cd ..
  830.      $ mv DIR DIR.orig
  831.      $ cvs checkout yoyodyne/DIR       # Explanation below
  832.      $ ls -R yoyodyne
  833.      $ rm -r DIR.orig
  834. Erasing the original sources is a good idea, to make sure that you do
  835. not accidentally edit them in DIR, bypassing CVS.  Of course, it would
  836. be wise to make sure that you have a backup of the sources before you
  837. remove them.
  838.    The `checkout' command can either take a module name as argument (as
  839. it has done in all previous examples) or a path name relative to
  840. `$CVSROOT', as it did in the example above.
  841.    It is a good idea to check that the permissions CVS sets on the
  842. directories inside `$CVSROOT' are reasonable, and that they belong to
  843. the proper groups.  *Note File permissions::.
  844. File: cvs.info,  Node: From scratch,  Prev: From files,  Up: Setting up the files
  845. Creating a module from scratch
  846. ------------------------------
  847.    For a new project, the easiest thing to do is probably to create an
  848. empty directory structure, like this:
  849.      $ mkdir tc
  850.      $ mkdir tc/man
  851.      $ mkdir tc/testing
  852.    After that, you use the `import' command to create the corresponding
  853. (empty) directory structure inside the repository:
  854.      $ cd tc
  855.      $ cvs import -m "Created directory structure" yoyodyne/DIR yoyo start
  856.    Then, use `add' to add files (and new directories) as they appear.
  857.    Check that the permissions CVS sets on the directories inside
  858. `$CVSROOT' are reasonable.
  859. File: cvs.info,  Node: Defining the module,  Prev: Setting up the files,  Up: Starting a new project
  860. Defining the module
  861. ===================
  862.    The next step is to define the module in the `modules' file.  This
  863. is not strictly necessary, but modules can be convenient in grouping
  864. together related files and directories.
  865.    In simple cases these steps are sufficient to define a module.
  866.   1. Get a working copy of the modules file.
  867.           $ cvs checkout modules
  868.           $ cd modules
  869.   2. Edit the file and insert a line that defines the module.  *Note
  870.      Intro administrative files::, for an introduction.  *Note
  871.      modules::, for a full description of the modules file.  You can
  872.      use the following line to define the module `tc':
  873.           tc   yoyodyne/tc
  874.   3. Commit your changes to the modules file.
  875.           $ cvs commit -m "Added the tc module." modules
  876.   4. Release the modules module.
  877.           $ cd ..
  878.           $ cvs release -d modules
  879. File: cvs.info,  Node: Multiple developers,  Next: Branches,  Prev: Starting a new project,  Up: Top
  880. Multiple developers
  881. *******************
  882.    When more than one person works on a software project things often
  883. get complicated.  Often, two people try to edit the same file
  884. simultaneously.  Some other version control systems (including RCS and
  885. SCCS) try to solve that particular problem by introducing "file
  886. locking", so that only one person can edit each file at a time.
  887. Unfortunately, file locking can be very counter-productive.  If two
  888. persons want to edit different parts of a file, there may be no reason
  889. to prevent either of them from doing so.
  890.    CVS does not use file locking.  Instead, it allows many people to
  891. edit their own "working copy" of a file simultaneously.  The first
  892. person that commits his changes has no automatic way of knowing that
  893. another has started to edit it.  Others will get an error message when
  894. they try to commit the file.  They must then use CVS commands to bring
  895. their working copy up to date with the repository revision.  This
  896. process is almost automatic, and explained in this chapter.
  897.    There are many ways to organize a team of developers.  CVS does not
  898. try to enforce a certain organization.  It is a tool that can be used
  899. in several ways.  It is often useful to inform the group of commits you
  900. have done.  CVS has several ways of automating that process.  *Note
  901. Informing others::.  *Note Revision management::, for more tips on how
  902. to use CVS.
  903. * Menu:
  904. * File status::                 A file can be in several states
  905. * Updating a file::             Bringing a file up-to-date
  906. * Conflicts example::           An informative example
  907. * Informing others::            To cooperate you must inform
  908. * Concurrency::                 Simultaneous repository access
  909. * Watches::                     Mechanisms to track who is editing files
  910. File: cvs.info,  Node: File status,  Next: Updating a file,  Up: Multiple developers
  911. File status
  912. ===========
  913.    After you have checked out a file out from CVS, it is in one of
  914. these four states:
  915. Up-to-date
  916.      The file is identical with the latest revision in the repository.
  917. Locally modified
  918.      You have edited the file, and not yet committed your changes.
  919. Needing update
  920.      Someone else has committed a newer revision to the repository.
  921. Needing merge
  922.      Someone else have committed a newer revision to the repository,
  923.      and you have also made modifications to the file.
  924.    You can use the `status' command to find out the status of a given
  925. file.  *Note status::.
  926.